Add serve deploy and quickstart guides.#754
Conversation
Greptile SummaryThis PR adds two new documentation files for the Earth2Studio serve platform and fixes incorrect import paths in an existing doc:
The PR is documentation-only with no functional code changes. The import path corrections in the object storage README are accurate and align with the current module structure.
|
| Filename | Overview |
|---|---|
| serve/DEPLOY.md | New Lepton.AI deployment guide with dashboard setup instructions, storage configuration, and debugging tips. Straightforward documentation, no issues found. |
| serve/README.md | New quickstart guide with developer setup, inline Python example, container build instructions, and deployment references. The inline example diverges slightly from the actual source file it references. |
| serve/server/README_object_storage.md | Corrects three import paths from old api_client.* module paths to the current earth2studio.serve.client.* paths. All corrected paths verified to exist in the codebase. |
Last reviewed commit: 6e4463a
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
| start_time: list[datetime] = [datetime(2024, 1, 1, 0)], | ||
| num_steps: int = 20, | ||
| ): | ||
| """Run the deterministic workflow pipeline""" | ||
|
|
||
| run.deterministic(start_time, num_steps, self.model, self.data, io) | ||
|
|
||
| print("initializing ") | ||
| model = DeterministicEarth2Workflow() | ||
| print("calling model") | ||
| from earth2studio.io import ZarrBackend | ||
| io = ZarrBackend() | ||
| model(io) |
There was a problem hiding this comment.
Mutable default argument in documentation example
The start_time parameter uses a mutable default argument ([datetime(2024, 1, 1, 0)]), which is a well-known Python pitfall — the list is shared across all calls that don't provide this argument. This same pattern exists in the source file server/example_workflows/deterministic_earth2_workflow.py, so it's a pre-existing issue, but since this README is meant to guide new users, it may be worth using an immutable default (e.g., None with a check inside the method body) to avoid teaching the anti-pattern.
Additionally, the num_steps default here is 20, while the actual source file uses 6. If the intent is to mirror the source file, consider keeping these in sync to avoid confusion.
|
/blossom-ci |
shrek
left a comment
shrek
left a comment
There was a problem hiding this comment.
these are doc changes, and lgtm !
3 participants
Earth2Studio Pull Request
Description
Checklist
Dependencies